External Resources Worksheet

Introduction

It defines the data source configuration, LDAP connection and SMTP connection information used in the AlchemyJ workbook.

It contains the following sections:

• Data Source Configuration

• LDAP Connection

• SMTP Connection

• Kafka Connection

Data Source Configuration

Data source settings for this API. Multiple data source settings are supported.

Properties	Description
Disable	Yes - the data source is disabled. Empty - the data source is enabled.
Data Source ID	Unique ID of the data source. It must be in lowercase.
Obtain connection information from	Data source configuration - Use JDBC URL in the generated API. JNDI - Connect through JNDI in the generated API.
Database	AlchemyJ supporting database types: MsSql Oracle MSSQL PostgreSQL
Connection String	Database connection string used in the AlchemyJ Studio. For Oracle: Provider=OraOLEDB.Oracle.1;Password=[password];Persist Security Info=True;User ID=[user id];Data Source=[data source];Extended Properties="" Example: Provider=OraOLEDB.Oracle.1;Password=myPassword;Persist Security Info=True;User ID=myUsername;Data Source=localhost:1521/service_name;Extended Properties="" For MySQL: Driver={MySQL ODBC 5.2 Unicode Driver}; Server=[server address];DB=[database name];UId=[user id]; PWD=[password];OPTION=3; Example: Driver={MySQL ODBC 5.2 Unicode Driver}; Server=localhost;DB=test_db;UId=myUsername; PWD=myPassword;OPTION=3; For MSSQL: Driver={SQL Server}; Server=[server address];Database=[database name];UId=[user id]; Pwd=[password]; Example: Driver={SQL Server}; Server=localhost;Database=test_db;UId=myUsername; Pwd=myPassword; For PostgreSQL: Driver={PostgreSQL Unicode}; Server=[server address];Port=[port number]; Database=[database name];UId=[user id]; Pwd=[password]; Example: Driver={PostgreSQL Unicode}; Server=localhost; Port=5432; Database=test_db; UId=myUsername; Pwd=myPassword; If you do not want to expose the password in the connection string, use {0} to represent the password instead. When a database connection is needed in AlchemyJ Studio, it will show a dialog box for you to enter the password. The password will be used until the Excel is closed. For example, Oracle: Password={0} MySQL, MS SQL, PostgreSQL: Pwd={0}
JNDI name	JNDI Name if JNDI is used in the generated API.
JDBC URL	JDBC URL if JDBC URL is used in the generated API. Oracle: jdbc:oracle:thin:@[Host]:[Port]:[SID] For example: jdbc:oracle:thin:@localhost:1521:test_db MySQL: jdbc:mysql://[Host]:[Port]/[DB Name] For example: jdbc:mysql://localhost:3306/test_db MSSQL: jdbc:sqlserver://[serverName]:[portNumber];[property=value] For example: jdbc:sqlserver://localhost:1433; databaseName=test_db; PostgreSQL: jdbc:postgresql://[serverName]:[portNumber]/[DB Name] For example: jdbc:postgresql://localhost:5432/test_db
User name	User name for database.
Password	Password for the user name.
Minimum number of idle connections	The minimum number of idle connections. The default is 5.
Maximum pool size	The maximum number of connections allowed in the pool. The default is 15.
Connection timeout (ms)	Connection Timeout in milliseconds. The default is 30000ms.
Idle timeout (ms)	Idle Timeout in milliseconds. The default is 600000ms.

LDAP Connection

LDAP connection for this API. Multiple LDAP connection settings are supported.

Properties	Description
Disable	Yes - the connection is disabled. Empty - the connection is enabled.
LDAP Connection ID	Unique ID of the LDAP connection. It must be in lowercase.
Server URL	LDAP Server URL.
Base Path	LDAP Base information.
User Name	Default user to access the LDAP server.
Password	Password of the user name. If the password is in an encrypted form, AlchemyJ Studio will show a dialog box for you to enter the password at the first time a LDAP connection is needed. The password will be used until Excel is closed.

SMTP Connection

SMTP connection for this API. Multiple SMTP connection settings are supported.

Properties	Description
Disable	Yes - the connection is disabled. Empty - the connection is enabled.
SMTP Connection ID	Unique ID of the SMTP connection. It must be in lowercase.
Host	SMTP host name or IP address.
Port	Port number of the SMTP server
User Name	When user use the extended function ajSendEmailBySMTP, the function will connect to the SMTP server with defined user here.
Password	Password of the user name. If the password is in an encrypted form, AlchemyJ Studio will show a dialog box for you to enter the password at the first time an SMTP connection is needed. The password will be used until Excel is closed.
Sender Address	Sender Address when user use the extended function ajSendEmail.

Kafka Connection

Kafka connection for this API. Multiple Kafka connection settings are supported.

Properties	Description
Disable	Yes - the connection is disabled. Empty - the connection is enabled.
Kafka Connection ID	Unique ID of the Kafka connection. It must be in lowercase.
Host:Port	The Host and port of the Kafka server.
Properties File Path	The path of the properties file which contains the additional properties to connect Kafka server. Refer to the Kafka official website for the supported properties. http://kafka.apache.org/28/documentation/#configuration